<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>PrecedingAxisIterator xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/jaxen/util/PrecedingAxisIterator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> org.jaxen.util;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * $Header$</em>
<a name="5" href="#5">5</a>   <em class="comment"> * $Revision: 1257 $</em>
<a name="6" href="#6">6</a>   <em class="comment"> * $Date: 2006-11-13 14:10:09 -0800 (Mon, 13 Nov 2006) $</em>
<a name="7" href="#7">7</a>   <em class="comment"> *</em>
<a name="8" href="#8">8</a>   <em class="comment"> * ====================================================================</em>
<a name="9" href="#9">9</a>   <em class="comment"> *</em>
<a name="10" href="#10">10</a>  <em class="comment"> * Copyright 2000-2005 bob mcwhirter &amp; James Strachan.</em>
<a name="11" href="#11">11</a>  <em class="comment"> * All rights reserved.</em>
<a name="12" href="#12">12</a>  <em class="comment"> *</em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Redistribution and use in source and binary forms, with or without</em>
<a name="15" href="#15">15</a>  <em class="comment"> * modification, are permitted provided that the following conditions are</em>
<a name="16" href="#16">16</a>  <em class="comment"> * met:</em>
<a name="17" href="#17">17</a>  <em class="comment"> * </em>
<a name="18" href="#18">18</a>  <em class="comment"> *   * Redistributions of source code must retain the above copyright</em>
<a name="19" href="#19">19</a>  <em class="comment"> *     notice, this list of conditions and the following disclaimer.</em>
<a name="20" href="#20">20</a>  <em class="comment"> * </em>
<a name="21" href="#21">21</a>  <em class="comment"> *   * Redistributions in binary form must reproduce the above copyright</em>
<a name="22" href="#22">22</a>  <em class="comment"> *     notice, this list of conditions and the following disclaimer in the</em>
<a name="23" href="#23">23</a>  <em class="comment"> *     documentation and/or other materials provided with the distribution.</em>
<a name="24" href="#24">24</a>  <em class="comment"> * </em>
<a name="25" href="#25">25</a>  <em class="comment"> *   * Neither the name of the Jaxen Project nor the names of its</em>
<a name="26" href="#26">26</a>  <em class="comment"> *     contributors may be used to endorse or promote products derived </em>
<a name="27" href="#27">27</a>  <em class="comment"> *     from this software without specific prior written permission.</em>
<a name="28" href="#28">28</a>  <em class="comment"> * </em>
<a name="29" href="#29">29</a>  <em class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS</em>
<a name="30" href="#30">30</a>  <em class="comment"> * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED</em>
<a name="31" href="#31">31</a>  <em class="comment"> * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</em>
<a name="32" href="#32">32</a>  <em class="comment"> * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER</em>
<a name="33" href="#33">33</a>  <em class="comment"> * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</em>
<a name="34" href="#34">34</a>  <em class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</em>
<a name="35" href="#35">35</a>  <em class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</em>
<a name="36" href="#36">36</a>  <em class="comment"> * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</em>
<a name="37" href="#37">37</a>  <em class="comment"> * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</em>
<a name="38" href="#38">38</a>  <em class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</em>
<a name="39" href="#39">39</a>  <em class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</em>
<a name="40" href="#40">40</a>  <em class="comment"> *</em>
<a name="41" href="#41">41</a>  <em class="comment"> * ====================================================================</em>
<a name="42" href="#42">42</a>  <em class="comment"> * This software consists of voluntary contributions made by many</em>
<a name="43" href="#43">43</a>  <em class="comment"> * individuals on behalf of the Jaxen Project and was originally</em>
<a name="44" href="#44">44</a>  <em class="comment"> * created by bob mcwhirter &lt;bob@werken.com> and</em>
<a name="45" href="#45">45</a>  <em class="comment"> * James Strachan &lt;jstrachan@apache.org>.  For more information on the</em>
<a name="46" href="#46">46</a>  <em class="comment"> * Jaxen Project, please see &lt;<a href="http://www.jaxen.org/" target="alexandria_uri">http://www.jaxen.org/</a>>.</em>
<a name="47" href="#47">47</a>  <em class="comment"> *</em>
<a name="48" href="#48">48</a>  <em class="comment"> * $Id: PrecedingAxisIterator.java 1257 2006-11-13 22:10:09Z elharo $</em>
<a name="49" href="#49">49</a>  <em class="comment">*/</em>
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>  <strong>import</strong> org.jaxen.JaxenConstants;
<a name="52" href="#52">52</a>  <strong>import</strong> org.jaxen.JaxenRuntimeException;
<a name="53" href="#53">53</a>  <strong>import</strong> org.jaxen.Navigator;
<a name="54" href="#54">54</a>  <strong>import</strong> org.jaxen.UnsupportedAxisException;
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>  <strong>import</strong> java.util.ArrayList;
<a name="57" href="#57">57</a>  <strong>import</strong> java.util.Iterator;
<a name="58" href="#58">58</a>  <strong>import</strong> java.util.ListIterator;
<a name="59" href="#59">59</a>  <strong>import</strong> java.util.NoSuchElementException;
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>  <em>/**</em>
<a name="62" href="#62">62</a>  <em> * &lt;p></em>
<a name="63" href="#63">63</a>  <em> * Represents the XPath &lt;code>preceding&lt;/code> axis. </em>
<a name="64" href="#64">64</a>  <em> * The "&lt;code>preceding&lt;/code> axis contains all nodes in the same document as the context </em>
<a name="65" href="#65">65</a>  <em> * node that are before the context node in document order, excluding any ancestors </em>
<a name="66" href="#66">66</a>  <em> * and excluding attribute nodes and namespace nodes."</em>
<a name="67" href="#67">67</a>  <em> * </em>
<a name="68" href="#68">68</a>  <em> * &lt;p></em>
<a name="69" href="#69">69</a>  <em> * This implementation of '&lt;code>preceding&lt;/code>' works like so:</em>
<a name="70" href="#70">70</a>  <em> * the &lt;code>preceding&lt;/code> axis includes preceding siblings of this node and </em>
<a name="71" href="#71">71</a>  <em> * their descendants. Also, for each ancestor node of this node, it includes</em>
<a name="72" href="#72">72</a>  <em> * all preceding siblings of that ancestor, and their descendants. Finally, it</em>
<a name="73" href="#73">73</a>  <em> * includes the ancestor nodes themselves.</em>
<a name="74" href="#74">74</a>  <em> * &lt;/p></em>
<a name="75" href="#75">75</a>  <em> * </em>
<a name="76" href="#76">76</a>  <em> * &lt;p></em>
<a name="77" href="#77">77</a>  <em> * The reversed &lt;code>descendant-or-self&lt;/code> axes that are required are calculated using a</em>
<a name="78" href="#78">78</a>  <em> * stack of reversed 'child-or-self' axes. When asked for a node, it is always taken</em>
<a name="79" href="#79">79</a>  <em> * from a child-or-self axis. If it was the last node on that axis, the node is returned.</em>
<a name="80" href="#80">80</a>  <em> * Otherwise, this axis is pushed on the stack, and the process is repeated with the child-or-self</em>
<a name="81" href="#81">81</a>  <em> * of the node. Eventually this recurses down to the last descendant of any node, then works</em>
<a name="82" href="#82">82</a>  <em> * back up to the root.</em>
<a name="83" href="#83">83</a>  <em> * &lt;/p></em>
<a name="84" href="#84">84</a>  <em> * </em>
<a name="85" href="#85">85</a>  <em> * &lt;p></em>
<a name="86" href="#86">86</a>  <em> * Most object models could provide a faster implementation of the reversed</em>
<a name="87" href="#87">87</a>  <em> * 'children-or-self' used here.&lt;/p></em>
<a name="88" href="#88">88</a>  <em> * </em>
<a name="89" href="#89">89</a>  <em> * @version 1.2b12</em>
<a name="90" href="#90">90</a>  <em> */</em>
<a name="91" href="#91">91</a>  <strong>public</strong> <strong>class</strong> <a href="../../../org/jaxen/util/PrecedingAxisIterator.html">PrecedingAxisIterator</a> implements Iterator
<a name="92" href="#92">92</a>  {
<a name="93" href="#93">93</a>      <strong>private</strong> Iterator ancestorOrSelf;
<a name="94" href="#94">94</a>      <strong>private</strong> Iterator precedingSibling;
<a name="95" href="#95">95</a>      <strong>private</strong> ListIterator childrenOrSelf;
<a name="96" href="#96">96</a>      <strong>private</strong> ArrayList stack;
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <strong>private</strong> <a href="../../../org/jaxen/Navigator.html">Navigator</a> navigator;
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <em>/**</em>
<a name="101" href="#101">101</a> <em>     * Create a new &lt;code>preceding&lt;/code> axis iterator.</em>
<a name="102" href="#102">102</a> <em>     * </em>
<a name="103" href="#103">103</a> <em>     * @param contextNode the node to start from</em>
<a name="104" href="#104">104</a> <em>     * @param navigator the object model specific navigator</em>
<a name="105" href="#105">105</a> <em>     */</em>
<a name="106" href="#106">106</a>     <strong>public</strong> <a href="../../../org/jaxen/util/PrecedingAxisIterator.html">PrecedingAxisIterator</a>(Object contextNode,
<a name="107" href="#107">107</a>                                  <a href="../../../org/jaxen/Navigator.html">Navigator</a> navigator) throws UnsupportedAxisException
<a name="108" href="#108">108</a>     {
<a name="109" href="#109">109</a>         <strong>this</strong>.navigator = navigator;
<a name="110" href="#110">110</a>         <strong>this</strong>.ancestorOrSelf = navigator.getAncestorOrSelfAxisIterator(contextNode);
<a name="111" href="#111">111</a>         <strong>this</strong>.precedingSibling = JaxenConstants.EMPTY_ITERATOR;
<a name="112" href="#112">112</a>         <strong>this</strong>.childrenOrSelf = JaxenConstants.EMPTY_LIST_ITERATOR;
<a name="113" href="#113">113</a>         <strong>this</strong>.stack = <strong>new</strong> ArrayList();
<a name="114" href="#114">114</a>     }
<a name="115" href="#115">115</a> 
<a name="116" href="#116">116</a> 
<a name="117" href="#117">117</a>     <em>/**</em>
<a name="118" href="#118">118</a> <em>     * Returns true if there are any preceding nodes remaining; false otherwise.</em>
<a name="119" href="#119">119</a> <em>     * </em>
<a name="120" href="#120">120</a> <em>     * @return true if any preceding nodes remain; false otherwise</em>
<a name="121" href="#121">121</a> <em>     * </em>
<a name="122" href="#122">122</a> <em>     * @see java.util.Iterator#hasNext()</em>
<a name="123" href="#123">123</a> <em>     */</em>
<a name="124" href="#124">124</a>     <strong>public</strong> <strong>boolean</strong> hasNext()
<a name="125" href="#125">125</a>     {
<a name="126" href="#126">126</a>         <strong>try</strong>
<a name="127" href="#127">127</a>         {
<a name="128" href="#128">128</a>             <strong>while</strong> (!childrenOrSelf.hasPrevious())
<a name="129" href="#129">129</a>             {
<a name="130" href="#130">130</a>                 <strong>if</strong> (stack.isEmpty())
<a name="131" href="#131">131</a>                 {
<a name="132" href="#132">132</a>                     <strong>while</strong> (!precedingSibling.hasNext())
<a name="133" href="#133">133</a>                     {
<a name="134" href="#134">134</a>                         <strong>if</strong> (!ancestorOrSelf.hasNext())
<a name="135" href="#135">135</a>                         {
<a name="136" href="#136">136</a>                             <strong>return</strong> false;
<a name="137" href="#137">137</a>                         }
<a name="138" href="#138">138</a>                         Object contextNode = ancestorOrSelf.next();
<a name="139" href="#139">139</a>                         precedingSibling = <strong>new</strong> <a href="../../../org/jaxen/util/PrecedingSiblingAxisIterator.html">PrecedingSiblingAxisIterator</a>(contextNode, navigator);
<a name="140" href="#140">140</a>                     }
<a name="141" href="#141">141</a>                     Object node = precedingSibling.next();
<a name="142" href="#142">142</a>                     childrenOrSelf = childrenOrSelf(node);
<a name="143" href="#143">143</a>                 }
<a name="144" href="#144">144</a>                 <strong>else</strong>
<a name="145" href="#145">145</a>                 {
<a name="146" href="#146">146</a>                     childrenOrSelf = (ListIterator) stack.remove(stack.size()-1);
<a name="147" href="#147">147</a>                 }
<a name="148" href="#148">148</a>             }
<a name="149" href="#149">149</a>             <strong>return</strong> <strong>true</strong>;
<a name="150" href="#150">150</a>         }
<a name="151" href="#151">151</a>         <strong>catch</strong> (UnsupportedAxisException e)
<a name="152" href="#152">152</a>         {
<a name="153" href="#153">153</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/jaxen/JaxenRuntimeException.html">JaxenRuntimeException</a>(e);
<a name="154" href="#154">154</a>         }
<a name="155" href="#155">155</a>     }
<a name="156" href="#156">156</a> 
<a name="157" href="#157">157</a>     <strong>private</strong> ListIterator childrenOrSelf(Object node)
<a name="158" href="#158">158</a>     {
<a name="159" href="#159">159</a>         <strong>try</strong>
<a name="160" href="#160">160</a>         {
<a name="161" href="#161">161</a>             ArrayList reversed = <strong>new</strong> ArrayList();
<a name="162" href="#162">162</a>             reversed.add(node);
<a name="163" href="#163">163</a>             Iterator childAxisIterator = navigator.getChildAxisIterator(node);
<a name="164" href="#164">164</a>             <strong>if</strong> (childAxisIterator != <strong>null</strong>)
<a name="165" href="#165">165</a>             {
<a name="166" href="#166">166</a>                 <strong>while</strong> (childAxisIterator.hasNext())
<a name="167" href="#167">167</a>                 {
<a name="168" href="#168">168</a>                     reversed.add(childAxisIterator.next());
<a name="169" href="#169">169</a>                 }
<a name="170" href="#170">170</a>             }
<a name="171" href="#171">171</a>             <strong>return</strong> reversed.listIterator(reversed.size());
<a name="172" href="#172">172</a>         }
<a name="173" href="#173">173</a>         <strong>catch</strong> (UnsupportedAxisException e)
<a name="174" href="#174">174</a>         {
<a name="175" href="#175">175</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/jaxen/JaxenRuntimeException.html">JaxenRuntimeException</a>(e);
<a name="176" href="#176">176</a>         }
<a name="177" href="#177">177</a>     }
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a>     <em>/**</em>
<a name="180" href="#180">180</a> <em>     * Returns the next preceding node.</em>
<a name="181" href="#181">181</a> <em>     * </em>
<a name="182" href="#182">182</a> <em>     * @return the next preceding node</em>
<a name="183" href="#183">183</a> <em>     * </em>
<a name="184" href="#184">184</a> <em>     * @throws NoSuchElementException if no preceding nodes remain</em>
<a name="185" href="#185">185</a> <em>     * </em>
<a name="186" href="#186">186</a> <em>     * @see java.util.Iterator#next()</em>
<a name="187" href="#187">187</a> <em>     */</em>
<a name="188" href="#188">188</a>     <strong>public</strong> Object next() throws NoSuchElementException
<a name="189" href="#189">189</a>     {
<a name="190" href="#190">190</a>         <strong>if</strong> (!hasNext())
<a name="191" href="#191">191</a>         {
<a name="192" href="#192">192</a>             <strong>throw</strong> <strong>new</strong> NoSuchElementException();
<a name="193" href="#193">193</a>         }
<a name="194" href="#194">194</a>         <strong>while</strong> (<strong>true</strong>)
<a name="195" href="#195">195</a>         {
<a name="196" href="#196">196</a>             Object result = childrenOrSelf.previous();
<a name="197" href="#197">197</a>             <strong>if</strong> (childrenOrSelf.hasPrevious())
<a name="198" href="#198">198</a>             {
<a name="199" href="#199">199</a>                 <em class="comment">// if this isn't 'self' construct 'descendant-or-self'</em>
<a name="200" href="#200">200</a>                 stack.add(childrenOrSelf);
<a name="201" href="#201">201</a>                 childrenOrSelf = childrenOrSelf(result);
<a name="202" href="#202">202</a>                 <strong>continue</strong>;
<a name="203" href="#203">203</a>             }
<a name="204" href="#204">204</a>             <strong>return</strong> result;
<a name="205" href="#205">205</a>         }
<a name="206" href="#206">206</a>     }
<a name="207" href="#207">207</a> 
<a name="208" href="#208">208</a> 
<a name="209" href="#209">209</a>     <em>/**</em>
<a name="210" href="#210">210</a> <em>     * This operation is not supported.</em>
<a name="211" href="#211">211</a> <em>     * </em>
<a name="212" href="#212">212</a> <em>     * @throws UnsupportedOperationException always</em>
<a name="213" href="#213">213</a> <em>     */</em>
<a name="214" href="#214">214</a>     <strong>public</strong> <strong>void</strong> remove() throws UnsupportedOperationException
<a name="215" href="#215">215</a>     {
<a name="216" href="#216">216</a>         <strong>throw</strong> <strong>new</strong> UnsupportedOperationException();
<a name="217" href="#217">217</a>     }
<a name="218" href="#218">218</a>     
<a name="219" href="#219">219</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

